Frame—Clarify relationship of :shadow-type & .flat
authorDaniel Boles <dboles@src.gnome.org>
Tue, 21 Feb 2017 21:13:43 +0000 (21:13 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Tue, 21 Feb 2017 21:26:41 +0000 (21:26 +0000)
gtk/gtkframe.c

index 3b3ba300d3537dac24d8339ffb9ac283497a2a50..7095c570ad203e39e7c0c4db3db99ea6f131f92e 100644 (file)
@@ -79,7 +79,8 @@
  * ]|
  *
  * GtkFrame has a main CSS node with name frame. This node can be given the
- * style class .flat, which disables drawing of the border.
+ * style class .flat, which disables drawing of the border, equivalent to
+ * calling gtk_frame_set_shadow_type() with GTK_SHADOW_NONE.
  */
 
 struct _GtkFramePrivate
@@ -615,7 +616,10 @@ gtk_frame_get_label_align (GtkFrame *frame,
  * @frame: a #GtkFrame
  * @type: the new #GtkShadowType
  * 
- * Sets the shadow type for @frame.
+ * Sets the #GtkFrame:shadow-type for @frame, i.e. whether it is drawn without
+ * (GTK_SHADOW_NONE) or with (other values) a visible border. Values other than
+ * GTK_SHADOW_NONE are treated identically by #GtkFrame. The chosen type is
+ * applied by removing or adding the .flat class to the main CSS node, frame.
  **/
 void
 gtk_frame_set_shadow_type (GtkFrame      *frame,